UniqueToken.md: API documentation for UniqueToken.md #179
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JBludau
requested changes
Oct 17, 2022
|
Document the extra constructor for UniqueTokenScope==Global as: |
Done |
JBludau
reviewed
Sep 7, 2024
| Description | ||
| ------------ | ||
|
|
||
| ``UniqueToken`` is a portable way to acquire a unique ID for calling a thread (``thread-id`` is not portable execution environments). ``UniqueToken`` is thus analogous to ``thread-id``, and has a ``UniqueTokenScope`` template parameter (default: ``Instance``, but can be ``Global``). |
There was a problem hiding this comment.
Suggested change
| ``UniqueToken`` is a portable way to acquire a unique ID for calling a thread (``thread-id`` is not portable execution environments). ``UniqueToken`` is thus analogous to ``thread-id``, and has a ``UniqueTokenScope`` template parameter (default: ``Instance``, but can be ``Global``). | |
| ``UniqueToken`` is a portable way to acquire a unique ID identifying a thread. The scope of the unique ID is selected via the ``UniqueTokenScope`` template parameter (defaults to ``Instance``, but can be set to``Global``). |
| ``UniqueToken <ExecutionSpace> token`` *can* be called inside a parallel region, *but* must be released at the end of *each* iteration. | ||
|
|
||
|
|
||
| * ``UniqueTokenScope``: defaults to ``Instance``, but ``Global`` can be employed when thread awareness is needed for more than one ``ExecutionSpace`` instance, as in the case of submitting concurrent kernels to CUDA streams. |
There was a problem hiding this comment.
Suggested change
| * ``UniqueTokenScope``: defaults to ``Instance``, but ``Global`` can be employed when thread awareness is needed for more than one ``ExecutionSpace`` instance, as in the case of submitting concurrent kernels to CUDA streams. |
moved to the parameters above
| Interface | ||
| --------- | ||
|
|
||
| .. cppkokkos:class:: template <class ExecutionSpace, UniqueTokenScope :: Global> UniqueToken |
There was a problem hiding this comment.
Suggested change
| .. cppkokkos:class:: template <class ExecutionSpace, UniqueTokenScope :: Global> UniqueToken | |
| .. cppkokkos:class:: template <class ExecutionSpace=DefaultExecutionSpace, UniqueTokenScope = UniqueTokenScope::Instance> UniqueToken |
Comment on lines
+22
to
+33
| Parameters | ||
| ----------- | ||
|
|
||
| * ``ExecutionSpace``: See `Execution Spaces <../execution_spaces.html>`_ | ||
|
|
||
| .. note:: | ||
| In a parallel region, before the main computation, a pool of ``UniqueToken`` (integer) Id is generated, and each Id is released following iteration. | ||
|
|
||
| .. warning:: | ||
| ``UniqueToken <ExecutionSpace> token`` *can* be called inside a parallel region, *but* must be released at the end of *each* iteration. | ||
|
|
||
|
|
There was a problem hiding this comment.
Suggested change
| Parameters | |
| ----------- | |
| * ``ExecutionSpace``: See `Execution Spaces <../execution_spaces.html>`_ | |
| .. note:: | |
| In a parallel region, before the main computation, a pool of ``UniqueToken`` (integer) Id is generated, and each Id is released following iteration. | |
| .. warning:: | |
| ``UniqueToken <ExecutionSpace> token`` *can* be called inside a parallel region, *but* must be released at the end of *each* iteration. | |
| Parameters | |
| ----------- | |
| * ``ExecutionSpace``: See `Execution Spaces <../execution_spaces.html>`_ | |
| * ``UniqueTokenScope``: defaults to ``Instance`` which results in every instance of ``UniqueToken`` being independent. In contrast ``Global`` uses one set of IDs for all instances. | |
Comment on lines
+37
to
+43
| Constructors | ||
| ------------- | ||
| .. cppkokkos:function:: UniqueToken(size_t max_size, ExecutionSpace execution_space, UniqueTokenScope :: Global) | ||
|
|
||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
Suggested change
| Constructors | |
| ------------- | |
| .. cppkokkos:function:: UniqueToken(size_t max_size, ExecutionSpace execution_space, UniqueTokenScope :: Global) | |
| Constructors | |
| ------------- | |
| .. cppkokkos:function:: UniqueToken(ExecutionSpace execution_space = ExecutionSpace()) | |
| Additionally for ``UniqueTokenScope==Instance`` | |
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
| .. cppkokkos:function:: UniqueToken(size_t max_size, ExecutionSpace execution_space=ExecutionSpace()) | |
| Sets an upper bound to the number of tokens. Requires ``max_size <= execution_space.concurrency()`` | |
| Token Interface | |
| --------------- | |
| .. cppkokkos:function:: size_type size() | |
| Returns the size of the token pool | |
| .. cppkokkos:function:: size_type acquire() | |
| Returns the token for the executing tread | |
| .. warning:: | |
| Acquired tokens *must* be released at the end of the parallel region in which they were acquired. | |
| .. cppkokkos:function:: void release(size_type idx) | |
| Releases the passed token |
@crtrott can you verify that it is max_size <= execution_space.concurrency() ... the comment in https://github.com/kokkos/kokkos/blob/d4af7c8302ecb4280c6215497bb2e39f9ed83c3f/core/src/Kokkos_UniqueToken.hpp#L78 would suggest otherwise, but the following lines suggest the opposite in my understanding. But I might be wrong here :-D
Comment on lines
+55
to
+58
| int id = token . acquire (); | ||
| RandomGen gen = pool (id ); | ||
| // Computation Body | ||
| token . release (id ); |
There was a problem hiding this comment.
Suggested change
| int id = token . acquire (); | |
| RandomGen gen = pool (id ); | |
| // Computation Body | |
| token . release (id ); | |
| auto id = token.acquire (); | |
| RandomGen gen = pool (id ); | |
| // Computation Body | |
| token.release (id ); |
Comment on lines
+63
to
+65
| void foo () { | ||
| UniqueToken < ExecSpace , UniqueTokenScope :: Global > token_foo ; | ||
| parallel_for ("L", RangePolicy < ExecSpace >( stream1 ,0,N), functor_a ( token_foo ));} |
There was a problem hiding this comment.
Suggested change
| void foo () { | |
| UniqueToken < ExecSpace , UniqueTokenScope :: Global > token_foo ; | |
| parallel_for ("L", RangePolicy < ExecSpace >( stream1 ,0,N), functor_a ( token_foo ));} | |
| void foo () { | |
| UniqueToken < ExecSpace , UniqueTokenScope :: Global > token_foo ; | |
| parallel_for ("L", RangePolicy < ExecSpace >( stream1 ,0,N), functor_a ( token_foo )); | |
| } |
Comment on lines
+67
to
+69
| void bar () { | ||
| UniqueToken < ExecSpace , UniqueTokenScope :: Global > token_bar ; | ||
| parallel_for ("L", RangePolicy < ExecSpace >( stream2 ,0,N), functor_b ( token_bar ));} |
There was a problem hiding this comment.
Suggested change
| void bar () { | |
| UniqueToken < ExecSpace , UniqueTokenScope :: Global > token_bar ; | |
| parallel_for ("L", RangePolicy < ExecSpace >( stream2 ,0,N), functor_b ( token_bar ));} | |
| void bar () { | |
| UniqueToken < ExecSpace , UniqueTokenScope :: Global > token_bar ; | |
| parallel_for ("L", RangePolicy < ExecSpace >( stream2 ,0,N), functor_b ( token_bar )); | |
| } |
Shouldn't it be |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is the first draft of API documentation for
UniqueTokencapability and is linked to the #5140 "catch all" Documentation issue.